Skip to main content
Web SDK Hero Light

Overview

The Suki Web SDK provides pre-built UI components and React hooks that allows you to seamlessly integrate ambient intelligence capabilities directly into your web application. Because this SDK includes all necessary user interface elements, you can quickly embed Suki’s ambient intelligence capabilities without having to design the frontend yourself. To integrate Suki’s AI capabilities, use Suki.js, our core JavaScript/TypeScript SDK. This package provides the essential methods and events for embedding the Suki Web SDK into your application. With the Suki Web SDK, you can add features like:
  • Ambient note generation
  • Medical transcription
  • Note management
While it is optimised for React, you can also easily integrate it with vanilla JavaScript or other frameworks.

How It Works

The following diagram illustrates the Web SDK architecture and workflow:

Architecture Workflow

Client Side (Your Web Application)

  • Your React, JavaScript, or web app that integrates the SDK
  • Core SDK package that handles authentication, session management, and communication
  • Pre-built UI for recording, transcription, and note display

Suki Backend

  • Validates partner credentials (Partner ID and token)
  • Manages audio streaming and processing
  • Processes audio in real-time and generates structured clinical notes

Data Flow

  1. Initialize SDK with partner credentials → Authenticate with suki backend
  2. Mount pre-built UI with encounter data
  3. User starts recording → SDK streams audio to Ambient Service
  4. AI Engine processes audio and generates notes
  5. Results return through Suki Backend → UI displays the note and transcript

Key Features

Ambient Note Generation

The SDK allows you to automatically capture spoken patient encounters and generate structured clinical notes in real time.
It uses AI to intelligently organize medical conversations into the correct clinical sections.
It leverages LOINC codes to segment content into sections like HPI, Assessment, and Physical Exam.
The feature runs passively in the background during consultations so it does not disrupt the provider’s workflow.

Medical Transcription

You can integrate high-accuracy medical transcription that supports specialty-specific terminology and multiple languages and accents.
The transcription supports specialty-specific terminology.
The transcription supports multiple languages and accents.

Note Management

The SDK includes features for managing clinical notes within your application.
A rich-text editor designed specifically for AI-generated clinical content. It supports editing, formatting, and section-level interaction.
A feature that allows users to view and manage both current and historical notes associated with a patient.

Key Benefits

The web SDK provides the following benefits:
Quickly add Suki’s features using our built-in UI.
Built for accuracy and speed in a web environment.
Let our components handle the Suki UI so your team can focus on your product.

Supported Platforms

The SDK is supported on the following platforms:

React

The SDK is supported on React.

Vanilla JavaScript

The SDK is supported on Vanilla JavaScript.

Other Frameworks

The SDK is supported on other frameworks like Vue, Angular, etc.

Next Steps

Refer to our Installation guide to get started with the Suki SDK.